/*******************************************************************************
 * Copyright 2011-2012 Dik Grapendaal
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package sh.grapendaal.tsuushin.core;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;

/**
 * Immutable bean which contains information about the current context. This
 * includes information such as the current bot and the current network.
 */
public class Context {
	private IrcBot bot;
	private Network network;

	/**
	 * The constructor takes all the current context information needed and
	 * stores them.
	 * 
	 * @param bot
	 *            The current bot.
	 * @param network
	 *            The current network.
	 */
	public Context(IrcBot bot, Network network) {
		this.bot = bot;
		this.network = network;
	}

	/**
	 * Returns the currently active bot.
	 * 
	 * @return Reference to the bot.
	 */
	public IrcBot getBot() {
		return bot;
	}

	/**
	 * Returns the currently active network.
	 * 
	 * @return Reference to the network.
	 */
	public Network getNetwork() {
		return network;
	}

	@Override
	public boolean equals(Object object) {
		if (!(object instanceof Context)) {
			return false;
		}
		if (this == object) {
			return true;
		}
		Context rhs = (Context) object;
		return new EqualsBuilder().append(this.bot, rhs.bot).append(this.network, rhs.network).isEquals();
	}

	@Override
	public int hashCode() {
		return new HashCodeBuilder().append(this.bot).append(this.network).toHashCode();
	}

	@Override
	public String toString() {
		return new ToStringBuilder(this).append(this.bot).append(this.network).toString();
	}
}
